Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Node Identifier Attribute #272

Merged
merged 4 commits into from
May 1, 2018
Merged

Conversation

JThramer
Copy link
Contributor

Implements #270. I'm somewhat unclear about how to document this change, as there is no CHANGELOG.MD in this project.

/cc @mapbox/navigation-ios

@JThramer JThramer added the bug label Apr 23, 2018
@JThramer JThramer self-assigned this Apr 23, 2018
Copy link
Contributor

@1ec5 1ec5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, other than the one documentation issue. Normally, it would be poor form to change the raw values of an enumeration. However, this library is pre-v1.0, so it’s technically up to any client to implement a migration path if desired. In practice, I don’t expect it to be a problem, because the archived representation of this enumeration is a string rather than the integer raw value (which we retain only for Objective-C bridging).

This project doesn’t currently maintain a running changelog. It wouldn’t hurt to start, but in the meantime, you can also stick something in a draft release.

@@ -3,36 +3,29 @@
/**
Attributes are metadata information for a route leg.

When most of the attributes are specified, the resulting route leg contains one attribute value for each segment in leg, where a segment is the straight line between two coordinates in the route leg’s full geometry. When the `MBAttributeOpenStreetMapNodeIdentifier` attribute is specified, the corresponding `RouteLeg` property contains one more value than each of the other attributes.
When most of the attributes are specified, the resulting route leg contains one attribute value for each segment in leg, where a segment is the straight line between two coordinates in the route leg’s full geometry.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace “most of the attributes are specified” with “any of the attributes is specified”, now that there’s no longer an exception to the rule.

@JThramer JThramer merged commit c9ea062 into master May 1, 2018
@JThramer JThramer deleted the jerrad/remove-nodeidentifier branch May 1, 2018 19:32
@1ec5 1ec5 added the backwards incompatible changes that break backwards compatibility of public API label Dec 18, 2018
@1ec5 1ec5 added this to the v0.21.0 milestone Dec 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backwards incompatible changes that break backwards compatibility of public API bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants